Skip to main content

Interface: TransceiverConfig

Transceiver Config for managed media

Hierarchy​

  • MediaBaseConfig

    ↳ TransceiverConfig

Properties​

allowAutoChangeOfDirection​

• allowAutoChangeOfDirection: boolean

content​

• content: string

Content Attributes

See

https://www.rfc-editor.org/rfc/rfc4796#section-5

Default Value

'main'

direction​

• direction: RTCRtpTransceiverDirection

Can be any of these sendrecv, sendonly, recvonly and inactive

dirty​

• dirty: boolean

Inherited from​

MediaBaseConfig.dirty

kind​

• kind: "audio" | "video"

Either audio or video

Overrides​

MediaBaseConfig.kind

mediaDescription​

• Optional mediaDescription: PexipMediaLine

relativeDirection​

• relativeDirection: boolean

remoteStreams​

• Optional remoteStreams: readonly MediaStream[]

sendEncodings​

• Optional sendEncodings: RTCRtpEncodingParameters[]

A list of RTCRtpEncodingParameters objects, each specifying the parameters for a single codec that could be used to encode the track's media

streams​

• streams: MediaStream[]

A list of local MediaStream objects to add to the transceiver's RTCRtpSender

track​

• track: undefined | null | MediaStreamTrack

A MediaStreamTrack to associate with the transceiver

transceiver​

• transceiver: undefined | RTCRtpTransceiver

Methods​

syncDirection​

▸ syncDirection(): void

Returns​

void

syncSenderParameters​

▸ syncSenderParameters(): Promise<void>

Returns​

Promise<void>

syncSenderTrack​

▸ syncSenderTrack(): Promise<void>

Returns​

Promise<void>

syncStreams​

▸ syncStreams(): void

Returns​

void

syncTransceiver​

▸ syncTransceiver(peer, config?): Promise<void>

Parameters​

NameType
peerRTCPeerConnection
config?SyncTransceiverOption

Returns​

Promise<void>

toString​

▸ toString(): string

Returns​

string

Inherited from​

MediaBaseConfig.toString